update documentation #146
update documentation #146
Conversation
mt-dfrey
force-pushed
the
update-documentation
branch
from
a692ddd to
2a3ec73
Compare
mt-dfrey
force-pushed
the
update-documentation
branch
from
2a3ec73 to
7fd3f27
Compare
src/typings.ts
Outdated
| token_type: string; | ||
| /** created at in seconds */ | ||
| created_at: number; | ||
| /** expiry in seconds */ |
There was a problem hiding this comment.
Is that seconds after created_at? If so, maybe we can be explicit about it.
There was a problem hiding this comment.
I copied the description from the RFC
The lifetime in seconds of the access token.
For example, the value "3600" denotes that the access token will expire in one hour from the time the response was generated.
and added a link to the spec on the type.
src/index.ts
Outdated
| * The only supported flow is authorization code grant with PKCE [PKCE](https://auth0.com/docs/flows/concepts/auth-code-pkce) | ||
| * If the user is not logged in yet this will show the login screen and redirect the guest to the consent screen after they log in. | ||
| * After the guest consents, they will be redirected to the redirect URI with an authorization code. | ||
| * If the user is already logged and has granted consent in the redirection happens immediately. |
There was a problem hiding this comment.
Line 108: "user" + "guest"
Line 109: "guest"
Line 110: "user"
I don't know which word is canonical, but I think we should stick to one.
Another suggestion on this line: "logged" -> "logged in"
There was a problem hiding this comment.
I replaced all guest with user in the docs.
Some of our APIs still have guest (like the scope guest_read and some API response objects).
But this is 99% consistent now.
There was a problem hiding this comment.
and yes, logged in is better 😁
mt-dfrey
force-pushed
the
update-documentation
branch
from
2e36d2f to
a3660a8
Compare
|
@mt-ronkorving @mt-rorykelly |
baac479 is a large diff because it generates a lot of static pages. You can ignore it for review (as long as you review the previous commit that makes changes to the typescript source files 😉 )